Skip to main content

mergMKDirectionsRouteGet

Type

function

Summary

Get a property of a directions route

Syntax

mergMKDirectionsRouteGet(<pDirectionID>, <pRouteNumber>, <pProperty>)

Description

Get a property of a directions route

Parameters

NameTypeDescription

pDirectionID

A directions ID as returned by the mergMKDirections message

pRouteNumber

A route number between 1 and the number of routes sent in the mergMKDirections message

pProperty

A route property

  • name : The string in this property is localized according to the user’s language preferences. You can display this string to the user from your app’s user interface so that the user can distinguish one route from another. The string itself describes the route using one of the route’s significant features. For example, a route that uses a major highway for a significant portion of the route might use that highway for its name.

  • distance : The distance of the route.

  • steps : The number of steps in the route.

  • transport type : This property reflects the primary transport type used for the route. Individual steps of the route might use different transport types. One of: automobile

    • walking
    • any
  • expected travel time : This expected travel time reflects the time it takes to traverse the route under ideal conditions. The actual amount of time may vary based on conditions.

  • advisory notices : This property contains additional information that is important for the user to know about the route. For example, it might note that a portion of the route is closed during the winter or after big storms.

Compatibility and Support

Introduced

LiveCode 8.0

OS

ios

Platforms

mobile

Thank you for your feedback!

Was this page helpful?